Fix proof namespace method descriptions to match implementation#340
Draft
Fix proof namespace method descriptions to match implementation#340
Conversation
Agent-Logs-Url: https://github.com/NethermindEth/docs/sessions/8b456cb4-a94d-4775-ad18-e32aa10c893c Co-authored-by: MarekM25 <9356351+MarekM25@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Fix proof module description mismatch in documentation
Fix proof namespace method descriptions to match implementation
May 6, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The
proof_getTransactionByHashandproof_getTransactionReceiptmethod descriptions in the docs were both inaccurate —getTransactionByHashwas described as returningeth_getTransactionReceiptdata, andgetTransactionReceiptwas described as returningeth_calldata with account/storage proofs. Neither matched the actual behavior inIProofRpcModule.cs.Changes
proof_getTransactionByHash: Updated description to correctly state it returnseth_getTransactionByHashdata plus a Merkle-Patricia proof of the transaction's inclusion in the block'stransactionsRoot, with an optional RLP-encoded block header whenincludeHeaderistrue.proof_getTransactionReceipt: Updated description to correctly state it returnseth_getTransactionReceiptdata plus Merkle-Patricia proofs of the transaction's inclusion intransactionsRootand the receipt's inclusion inreceiptsRoot, with an optional RLP-encoded block header whenincludeHeaderistrue.Applied to the current docs and all versioned docs (v1.33.0–v1.37.0).